Add gpBackMan — a backup management utility for Apache Cloudberry (Incubating) Backup. by woblerr · Pull Request #79 · apache/cloudberry-backup

woblerr · 2026-03-26T15:30:52Z

This PR adds gpBackMan, a utility for managing backups created by gpbackup. The tool provides an open-source alternative to the proprietary gpbackup_manager, addressing the need discussed in apache/cloudberry#1555

gpBackMan is based on the original gpbackman project (woblerr/gpbackman#39) and has been adapted for integration into the cloudberry-backup repository.

Motivation

The Apache Cloudberry community has expressed interest in having a backup management tool similar to gpbackup_manager, which is proprietary and not available in the open-source offering. gpBackMan fills this gap by providing essential backup management capabilities that work with the gpbackup_history.db SQLite history database format.

Features

gpBackMan provides the following functionality:

backup-info — display information about existing backups;
report-info — display the backup report for a specific backup;
backup-delete — delete a specific existing backup from local storage or using storage plugins;
backup-clean — delete all existing backups older than (or newer than) a specified time condition;
history-clean — clean deleted backups from the history database;

Both local storage and storage plugin-based backups are supported.

Related links

Discussion: apache/cloudberry#1555 — Availability of GPBackup_Manager in CB2.0
Issue: woblerr/gpbackman#39 — Support for Apache Cloudberry
Original project: gpbackman

Integrate gpbackman (https://github.com/woblerr/gpbackman) — a CLI utility for managing gpbackup backups — into the cloudberry-backup repo. YAML functionality (history-migrate, converters, utils_file) is not ported. Key changes: - Add gpbackman.go entry point with //go:build gpbackman tag - Create gpbackman/cmd/, gpbackman/gpbckpconfig/, gpbackman/textmsg/ - Migrate imports: greenplum-db/* → apache/cloudberry-* - Remove converter layer — use history.BackupConfig directly - Extract 11 BackupConfig methods into standalone functions (helpers.go) - Replace go-pretty/v6 with olekukonko/tablewriter - Add gpbackman to all Makefile targets (build/install/clean/package) - Version via ldflags: -X gpbackman/cmd.version - Rewrite unit tests from stdlib testing to Ginkgo/Gomega CLI subcommands: backup-info, backup-delete, backup-clean, history-clean, report-info.

- Replace searchFilter() with utils.Exists() in gpbckpconfig/helpers.go - Remove searchFilter() from gpbckpconfig/utils.go and its test - Replace getCurrentTimestamp() with history.CurrentTimestamp() in cmd/backup_delete.go - Remove getCurrentTimestamp() from cmd/wrappers.go and its test

Also add vscode to gitignore.

…n commands.

…sts.

tuhaihe · 2026-03-27T02:48:31Z

Hi @woblerr thanks for your great work!

A license question needs your confirmation here: do you still want to keep these files under the original MIT license, or adopt the Apache license? (MIT files are allowed to be introduced in ASF projects.)

[WARNING] Files with unapproved licenses:
  end_to_end/gpbackman_test.go
  gpbackman.go
  gpbackman/cmd/constants.go
  gpbackman/cmd/interfaces.go
  gpbackman/cmd/backup_info.go
  gpbackman/cmd/backup_clean.go
  gpbackman/cmd/cmd_suite_test.go
  gpbackman/cmd/report_info.go
  gpbackman/cmd/wrappers_test.go
  gpbackman/cmd/history_clean.go
  gpbackman/cmd/root.go
  gpbackman/cmd/backup_delete.go
  gpbackman/cmd/wrappers.go
  gpbackman/README.md
  gpbackman/COMMANDS.md
  gpbackman/gpbckpconfig/utils_db.go
  gpbackman/gpbckpconfig/struct.go
  gpbackman/gpbckpconfig/utils_test.go
  gpbackman/gpbckpconfig/cluster.go

Once you confirm, I can help with it.

woblerr · 2026-03-27T17:44:03Z

@tuhaihe
I agree to switch these files to the Apache 2.0 license.
It keeps licensing consistent across the entire cloudberry-backup repository.

The original gpbackman project will remain under MIT.
I plan to continue developing features there first and then port them to upstream (if these features will be useful for both projects), so the MIT → Apache 2.0 direction stays clean.

Is it acceptable for you?

tuhaihe · 2026-03-30T02:26:24Z

@tuhaihe I agree to switch these files to the Apache 2.0 license. It keeps licensing consistent across the entire cloudberry-backup repository.

The original gpbackman project will remain under MIT. I plan to continue developing features there first and then port them to upstream (if these features will be useful for both projects), so the MIT → Apache 2.0 direction stays clean.

Is it acceptable for you?

Yap, sounds good. I think it's perfectly fine.

Regarding these newly introduced files, would you be able to add the standard Apache License Header to them without affecting program execution to follow the ASF rules?

Markdown: Refer to https://github.com/apache/cloudberry/blob/84a84584c60433d04d633d7a7c4bd71b631e96dd/CONTRIBUTING.md?plain=1#L1-L18
Go files: https://github.com/apache/cloudberry/blob/84a84584c60433d04d633d7a7c4bd71b631e96dd/mcp-server/run_tests.sh#L2-L17, can be adapted to Go language comment style.

If it's not convenient for you to handle, I can add them as well.

tuhaihe · 2026-03-30T02:27:05Z

Hi @robertmu, could you help review this PR when you're available? Thanks!

robertmu

LGTM

woblerr · 2026-03-30T13:33:55Z

Regarding these newly introduced files, would you be able to add the standard Apache License Header to them without affecting program execution to follow the ASF rules?

@tuhaihe
I added Apache License headers in 1ca107a. Could you check it out?

tuhaihe · 2026-03-30T13:59:19Z

Regarding these newly introduced files, would you be able to add the standard Apache License Header to them without affecting program execution to follow the ASF rules?

@tuhaihe I added Apache License headers in 1ca107a. Could you check it out?

Excellent! Thanks @woblerr !

tuhaihe

+1.

woblerr added 10 commits March 15, 2026 23:10

Use same style as other main files.

e0e46c1

Disable auto-formatting for table headers in backup-info command.

6bf6e61

Add end-to-end tests for gpbackman functionality.

7c8ae66

Also add vscode to gitignore.

Fix typo in flag names and function for backup clean and history clea…

a2c7a38

…n commands.

Add gpbackman path setup and skip condition for old backup version te…

d89f557

…sts.

Refactor backup deletion commands to use direct SSH execution.

83a1e68

Merge branch 'main' into add_gpbackman

d8a925d

Add documentation for gpBackMan.

3ee71f1

woblerr mentioned this pull request Mar 26, 2026

Support for Apache Cloudberry and usage guidance in gpdemo environment woblerr/gpbackman#39

Open

tuhaihe requested review from robertmu and tuhaihe March 27, 2026 02:57

robertmu reviewed Mar 30, 2026

View reviewed changes

Add Apache License header to files in gpBackMan.

1ca107a

tuhaihe approved these changes Mar 30, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add gpBackMan — a backup management utility for Apache Cloudberry (Incubating) Backup.#79

Add gpBackMan — a backup management utility for Apache Cloudberry (Incubating) Backup.#79
woblerr wants to merge 11 commits intoapache:mainfrom
woblerr:add_gpbackman

woblerr commented Mar 26, 2026

Uh oh!

tuhaihe commented Mar 27, 2026 •

edited

Loading

Uh oh!

woblerr commented Mar 27, 2026

Uh oh!

tuhaihe commented Mar 30, 2026

Uh oh!

tuhaihe commented Mar 30, 2026

Uh oh!

robertmu left a comment

Uh oh!

woblerr commented Mar 30, 2026

Uh oh!

tuhaihe commented Mar 30, 2026

Uh oh!

tuhaihe left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

woblerr commented Mar 26, 2026

Motivation

Features

Related links

Uh oh!

tuhaihe commented Mar 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

woblerr commented Mar 27, 2026

Uh oh!

tuhaihe commented Mar 30, 2026

Uh oh!

tuhaihe commented Mar 30, 2026

Uh oh!

robertmu left a comment

Choose a reason for hiding this comment

Uh oh!

woblerr commented Mar 30, 2026

Uh oh!

tuhaihe commented Mar 30, 2026

Uh oh!

tuhaihe left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tuhaihe commented Mar 27, 2026 •

edited

Loading